جلد سخت سیاه و سفید
Product details
- Publisher : Manning (July 5, 2022)
- Language : English
- Paperback : 424 pages
- ISBN-10 : 1617296287
- ISBN-13 : 978-1617296284
کتاب Designing APIs with Swagger and OpenAPI
Follow real-world API projects from concept to production, and learn hands-on how to describe and design APIs using OpenAPI.
In Designing APIs with Swagger and OpenAPI you will learn how to:
Understand OpenAPI syntax and structure
Use Swagger and other tooling to create OpenAPI definitions
Design authentication and authorization
Turn an OpenAPI description into online documentation
Automate processes and generating code
Iterate an API design with user stories
Build a frontend against a mock server
Generate backend code with Swagger Codegen
Versioning an API and dodging breaking changes
Work with cross-functional teams
Designing APIs with Swagger and OpenAPI is a comprehensive guide to designing and describing your first RESTful API using the most widely adopted standards. Following expert instruction from Swagger core contributor Josh Ponelat and API consultant Lukas Rosenstock, you’ll spend each chapter progressively expanding the kind of APIs you’ll want to build in the real world. You’ll utilize OpenAPI and Swagger to help automate your workflow, and free up your time to work on more exciting features. Learn the syntax and structure of OpenAPI definitions, create and iterate on an API design with common tools, and release your API to the public.
Purchase of the print book includes a free eBook in PDF, Kindle, and ePub formats from Manning Publications.
About the technology
Create web APIs that customers and developers will love! Using Swagger, a collection of tools for defining and documenting REST APIs, you will build safe, controlled access to your software. And because Swagger implements the vendor-neutral OpenAPI specification, you’ll be building to the same standards adopted by Google, Microsoft, and Amazon.
About the book
Designing APIs with Swagger and OpenAPI introduces a design-first approach. Written for developers new to API design, it follows the lifecycle of an API project from concept to production. You’ll explore the dos and don’ts of APIs through progressively complete examples. You’ll get hands-on experience designing APIs for specific business needs, using open source tools to generate documentation, and building developer-friendly components like mocks and client SDKs.
What's inside
OpenAPI syntax and structure
Using Swagger to create OpenAPI definitions
Automating processes and generating code
Working with cross-functional teams
About the reader
For web developers. No prior knowledge of Swagger or OpenAPI required.
About the author
Josh Ponelat is the Swagger Open Source lead at SmartBear. Lukas Rosenstock is an independent software developer and API consultant.
Table of Contents
PART 1 DESCRIBING APIS
1 Introducing APIs and OpenAPI
2 Getting set up to make API requests
3 Our first taste of OpenAPI definitions
4 Using Swagger Editor to write OpenAPI definitions
5 Describing API responses
6 Creating resources
7 Adding authentication and authorization
8 Preparing and hosting API documentation
PART 2 DESIGN-FIRST
9 Designing a web application
10 Creating an API design using OpenAPI
11 Building a change workflow around API design–first
12 Implementing frontend code and reacting to changes
13 Building a backend with Node.js and Swagger Codegen
14 Integrating and releasing the web application
PART 3 EXTENDING APIS
15 Designing the next API iteration
16 Designing schemas with composition in OpenAPI
17 Scaling collection endpoints with filters and pagination
18 Supporting the unhappy path: Error handling with problem+json
19 Improving input validation with advanced JSON Schema
20 Versioning an API and handling breaking changes
21 The API prerelease checklist
منابع کتاب کتاب Designing APIs with Swagger and OpenAPI
پروژه های دنیای واقعی API را از مفهوم تا تولید دنبال کنید و به طور عملی نحوه توصیف و طراحی API ها را با استفاده از OpenAPI بیاموزید.
در طراحی API با Swagger و OpenAPI شما یاد خواهید گرفت که چگونه:
درک نحو و ساختار OpenAPI
استفاده از Swagger و ابزارهای دیگر برای ایجاد تعاریف OpenAPI
طراحی احراز هویت و مجوز
تبدیل توضیحات OpenAPI به مستندات آنلاین
خودکارسازی فرآیندها و تولید کد
تکرار طراحی API با داستان های کاربر
ساخت یک فرانت اند در برابر یک سرور ساختگی
ایجاد کد باطن با Swagger Codegen
نسخه API و اجتناب از تغییرات شکستن
کار با تیم های چندکاره
طراحی API با Swagger و OpenAPI یک راهنمای جامع برای طراحی و توصیف اولین API RESTful با استفاده از استانداردهای رایج است. با پیروی از دستورالعمل های متخصص از مشارکت کننده اصلی Swagger، جاش پونلات و مشاور API، لوکاس روزنستاک، هر فصل را به طور تدریجی برای گسترش نوع API هایی که می خواهید در دنیای واقعی بسازید صرف خواهید کرد. از OpenAPI و Swagger برای کمک به خودکارسازی گردش کار خود و آزاد کردن زمان خود برای کار بر روی ویژگی های هیجان انگیزتر استفاده خواهید کرد. نحو و ساختار تعاریف OpenAPI را بیاموزید، طراحی API را با ابزارهای رایج ایجاد و تکرار کنید و API خود را برای عموم منتشر کنید.
خرید کتاب چاپی شامل یک کتاب الکترونیکی رایگان در قالبهای PDF، Kindle و ePub از انتشارات منینگ است.
در مورد تکنولوژی
API های وب ایجاد کنید که مشتریان و توسعه دهندگان آن را دوست داشته باشند! با استفاده از Swagger، مجموعه ای از ابزارها برای تعریف و مستندسازی REST APIها، دسترسی ایمن و کنترل شده به نرم افزار خود ایجاد خواهید کرد. و از آنجایی که Swagger مشخصات OpenAPI خنثی از فروشنده را پیاده سازی می کند، شما مطابق با همان استانداردهایی خواهید بود که توسط گوگل، مایکروسافت و آمازون پذیرفته شده اند.
درباره کتاب
Designing APIs with Swagger and OpenAPIیک رویکرد طراحی اول را معرفی می کند. برای توسعه دهندگانی که تازه با طراحی API نوشته شده است، چرخه حیات یک پروژه API را از مفهوم تا تولید دنبال می کند. بایدها و نبایدهای APIها را از طریق نمونههای کامل و تدریجی بررسی خواهید کرد. شما تجربه عملی در طراحی APIها برای نیازهای خاص کسب و کار، استفاده از ابزارهای منبع باز برای تولید مستندات، و ساخت مؤلفههای مناسب برای توسعهدهنده مانند ماکها و SDKهای مشتری خواهید داشت.
آنچه در داخل
دستور و ساختار OpenAPI وجود دارد
استفاده از Swagger برای ایجاد تعاریف OpenAPI
خودکارسازی فرآیندها و تولید کد
کار با تیم های متقابل
درباره خواننده
برای توسعه دهندگان وب. نیازی به دانش قبلی Swagger یا OpenAPI نیست.
درباره نویسنده
جاش پونلاتمنبع باز Swagger در SmartBear است. Lukas Rosenstock یک توسعه دهنده نرم افزار مستقل و مشاور API است.
فهرست مطالب
بخش 1 توصیف APIS
1 معرفی API ها و OpenAPI
2 راه اندازی برای ایجاد درخواست های API
3 اولین طعم ما از تعاریف OpenAPI
4 استفاده از Swagger Editor برای نوشتن تعاریف OpenAPI
5 توصیف پاسخ های API
6 ایجاد منابع
7 افزودن اعتبار و تأیید اعتبار
8 میزبانی اسناد API
بخش 2 طراحی-اول
9 طراحی یک برنامه وب
10 ایجاد یک طراحی API با استفاده از OpenAPI
11 ایجاد یک گردش کار تغییر در اطراف طراحی API-اول
12 پیاده سازی کد فرانت اند و واکنش به تغییرات
13 ساخت بک اند با Node.js و Swagger Codegen
14 یکپارچه سازی و انتشار برنامه وب
قسمت 3 گسترش APIS
15 طراحی تکرار API بعدی
16 طراحی طرحواره ها با ترکیب بندی در OpenAPI
17 با مقیاس بندی فیلترها و نقاط پایانی مجموعه صفحه بندی
18 پشتیبانی از مسیر ناراضی: رسیدگی به خطا با problem+json
19 بهبود اعتبارسنجی ورودی با طرحواره JSON پیشرفته
20 نسخه API و مدیریت تغییرات شکستن
21 چک لیست پیش انتشار API
ارسال نظر درباره کتاب Designing APIs with Swagger and OpenAPI